---
layout: m1x_soap
title: Product Custom Value List
---

<h3><a name="product_custom_option_value.list-Module%3AComplexProductAPI"></a>Module: Complex Product API</h3>


<h4><a name="product_custom_option_value.list-Resource%3Aproductcustomoptionvalue"></a>Resource: product_custom_option_value</h4>


<h5><a name="product_custom_option_value.list-Method%3A"></a>Method:</h5>

<ul>
	<li>product_custom_option_value.list (SOAP V1)</li>
	<li>catalogProductCustomOptionValueList (SOAP V2)</li>
</ul>


<p>Allows you to retrieve the list of product custom option values. Note that the method is available only for the option <b>Select</b> Input Type.</p>


<p><b>Arguments:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> optionId </td>
<td> Option ID </td>
</tr>
<tr>
<td> string </td>
<td> store </td>
<td> Store view ID or code (optional) </td>
</tr>
</tbody></table>


<p><b>Returns</b>:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array <br class="atl-forced-newline" /> </td>
<td> result </td>
<td> Array of catalogProductCustomOptionValueList </td>
</tr>
</tbody></table>


<p>The <b>catalogProductCustomOptionValueListEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> value_id </td>
<td> Custom option value ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> title <br class="atl-forced-newline" /> </td>
<td> Custom option value title </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> price <br class="atl-forced-newline" /> </td>
<td> Option value price <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> price_type <br class="atl-forced-newline" /> </td>
<td> Price type. Possible values: "fixed" or "percent" <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sku <br class="atl-forced-newline" /> </td>
<td> Custom option value SKU <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sort_order <br class="atl-forced-newline" /> </td>
<td> Option value sort order (optional) <br class="atl-forced-newline" /> </td>
</tr>
</tbody></table>


<p><b>Faults</b>:</p>

<table><tbody>
<tr>
<th> Fault Code </th>
<th> Fault Message </th>
</tr>
<tr>
<td> 101 </td>
<td> Provided data is invalid. </td>
</tr>
<tr>
<td> 102 </td>
<td> Error while adding an option value. Details are in the error message. </td>
</tr>
</tbody></table>



<h4><a name="product_custom_option_value.list-Examples"></a>Examples</h4>

<h5><a name="product_custom_option_value.list-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/soap/?wsdl');

// If somestuff requires api authentification,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');

$result = $client-&gt;call($session, 'product_custom_option_value.list', '3');
var_dump($result);

// If you don't need the session anymore
//$client-&gt;endSession($session);</pre>
		</div>
</div></div>

<h5><a name="product_custom_option_value.list-RequestExampleSOAPV2"></a>Request Example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;catalogProductCustomOptionValueList($sessionId, '3');
var_dump($result);</pre>
		</div>
</div></div>


<h5><a name="product_custom_option_value.list-RequestExampleSOAPV2%28WSIComplianceMode%29"></a>Request Example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey'));

$result = $proxy-&gt;catalogProductCustomOptionValueList((object)array('sessionId' =&gt; $sessionId-&gt;result, 'optionId' =&gt; '3'));

var_dump($result-&gt;result);</pre>
		</div>
</div></div>


<h5><a name="product_custom_option_value.list-ResponseExampleSOAPV1"></a>Response Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: java; gutter: false">array
  0 =&gt;
    array
      'value_id' =&gt; string '1' (length=1)
      'title' =&gt; string 'monoblock' (length=9)
      'price' =&gt; string '139.9900' (length=8)
      'price_type' =&gt; string 'fixed' (length=5)
      'sku' =&gt; string 'monoblock' (length=9)
      'sort_order' =&gt; string '0' (length=1)
  1 =&gt;
    array
      'value_id' =&gt; string '2' (length=1)
      'title' =&gt; string 'slider' (length=6)
      'price' =&gt; string '239.9900' (length=8)
      'price_type' =&gt; string 'fixed' (length=5)
      'sku' =&gt; string 'slider' (length=6)
      'sort_order' =&gt; string '0' (length=1)</pre>
		</div>
</div></div>

<?php include(__ROOT__ . 'footer.php'); ?>
